home *** CD-ROM | disk | FTP | other *** search
/ Just Call Me Internet / Just Call Me Internet.iso / prog / atari / c / ltick03 / lazytick.txt < prev    next >
Text File  |  1993-06-15  |  8KB  |  215 lines
  1.  
  2.  
  3.                      LazyTick - The File Mailer for Lazy People
  4.  
  5.                           Preliminary Documentation May 93
  6.                                 (last update: 06/93)
  7.  
  8.                         *** PUBLIC DOMAIN AND UNSUPPORTED ***
  9.                         
  10.                         
  11.  
  12. >>> INTRODUCTION
  13. ----------------
  14.  
  15.     LazyTick is a simple file mailer (a program that receives files 
  16.     and .TIC files from other systems and send them to downlinks) for 
  17.     a Pandora Fidonet message base (commonly used on the Atari ST, and 
  18.     used by Bermuda, BED, the Lazy familly of utilities on other 
  19.     computers). Posting in the pandora message base is used for 
  20.     file announces. 
  21.  
  22.     It uses FILES.BBS-like download areas to put the files coming
  23.     from the net. It gets its configuration data from the Bermuda
  24.     configuration file, or a bermuda-like configuration file
  25.     (binkley.cfg on the unix and ST version of binkley is like that).
  26.     That allows to keep all passwords, addresses, aliasing data in a
  27.     single file.
  28.  
  29.     It uses FAREAS.BBS, an areas.bbs like, compatible with the
  30.     areas.bbs syntax used by LazyBBS and the LazyFix areafix utility.
  31.     The LazyFix utility is able to cope with suscribtion from sublinks
  32.     for both the AREAS.BBS (echomail) and the FAREAS.BBS (file echos).
  33.  
  34.     The files sent to others node are put in the outbound dir 
  35.     following TheBox or Binkley outbound format (the old binkley 3D
  36.     format).
  37.  
  38.     Note: It is not planned to provide a post-preliminary
  39.     documentation.
  40.     
  41.  
  42. >>> COMMAND LINE
  43. ----------------
  44.  
  45.     <void> (nothing)     
  46.         process incoming TIC files, tb.cfg/bermuda.cfg should 
  47.         be in the current directory.
  48.         eg: ltick
  49.     
  50.     hatch <file> <area> <desc>
  51.         hatch (send into the network) the file <file> in <area>
  52.         with description <desc>. WARNING: command line processing
  53.         consider each word to be a parameter, so if you want to enter
  54.         a description with spaces, read your shell manual to know how
  55.         to do that (usally by putting "" or '' around the desc).
  56.         eg: ltick hatch ltick01b.zip PDNCEE "LazyTick Wonderful Tick"
  57.  
  58.     debug
  59.         display parsed configuration files
  60.  
  61.  
  62. >>> FILE FORMATS
  63. ----------------
  64.  
  65.     LazyTick uses the following files, in the current directory at
  66.     startup, the MAILER environment var is not yet supported:
  67.  
  68.     tb.cfg
  69.     bermuda.cfg LazyTick tries both names. This are the tosser
  70.                 and/or mailer configuration file, and is described in
  71.                 your Bermuda or mailer documentation. LazyTick uses 
  72.                 the following lines:
  73.  
  74.                 Any line may be prefixed with "application bermuda" 
  75.                 or "application lazytick" not to interfere with
  76.                 other software.
  77.  
  78.                 address <4D-address> <option> <pointnet>
  79.                     your system address, can be multiple
  80.  
  81.                 key #<aka> <node>
  82.                 key !<password> <node>
  83.                     aliasing and passwords, can be multiple
  84.  
  85.                 statuslog <filename>
  86.                     the logile name
  87.                 
  88.                 loglevel <int>
  89.                     how much log (unused currently)
  90.  
  91.                 netfile <path>
  92.                     the inbound dir path
  93.             
  94.                 hold <path>
  95.                     the outbound dir path
  96.     
  97.                 binkley 
  98.                     [optional] toggles binkley outbound dir format
  99.  
  100.                 ticktemp <path>
  101.                     Path for temp dir for pending .TICs, it's 
  102.                     better to be different from your system generic 
  103.                     tempfile.
  104.  
  105.                 tickann <echo-area> <group> [<footer>]
  106.                     [optional] Announces files coming in filearea
  107.                     <group> in echomail. The optional footer is a file
  108.                     whose content will be posted at the end of the
  109.                     announce.
  110.  
  111.     fareas.bbs  It's like the areas.bbs format described in your
  112.                 fidonet software documentation.  
  113.  
  114.                 An add-on to this format is groups: all areas placed
  115.                 after a "-group grpname" line, will belong to the
  116.                 group named (8 ascii letters max) "grpname". There is
  117.                 no need to put one -group line before each area. The
  118.                 group name starting by _ are reserved for internal
  119.                 use.
  120.  
  121.                 Another add-on is description: a "-desc description"
  122.                 is used to describe the next area for display when
  123.                 needed.
  124.  
  125.                 The difference with areas.bbs is that the (echo)mail
  126.                 area radical is now the path to the file area.
  127.  
  128.                 Example:
  129.  
  130.                 First line is origin line
  131.                 ;
  132.                 -group EPnet
  133.                 -desc EPnet ascii text files
  134.                 f:\epnet\ascii\     EP-ASCII        2:10/20 2:3/4
  135.                 -desc EPnet magazines
  136.                 f:\epnet\mags\      EP-MAGS         2:10/20 2:100/100
  137.                 -group pdn
  138.                 -desc A nice group to hatch lazy software
  139.                 f:\pdn\pdnc         PDNCEE          2:242/242
  140.                 ; end of fareas.bbs
  141.             
  142.     
  143. >>> PORTING
  144. -----------
  145.  
  146.     It should be reasonably portable. Watch for timenix/time if your 
  147.     time_t is not time in seconds since a fixed date.
  148.  
  149.     For use with Binkley, check syntax is compatible with your version
  150.     and change the BERMCFG2 var to "binkley.cfg" in tick.h.
  151.  
  152.     To port to a system that does not use Pandora message base,
  153.     rewrite postmsg() in misc.c.
  154.  
  155.     To port to a system that does use another outbound format change
  156.     get_out_fname in config.c and eventually send_tic() in tick.c.
  157.  
  158.     Parts are tick.c,config.c,announce.c,misc.c,crc32.c to compile
  159.     and link to 'tick'.
  160.  
  161.  
  162. >>> MANIFEST
  163. ------------
  164.  
  165.     You should have received the following files in the standard 
  166.     distribution:
  167.  
  168.     [source]
  169.     tick.h                  TICK config
  170.     tick.c                  Main module
  171.     config.c;config.h       Config file(s) processing
  172.     misc.c;misc.h           Misc funcs
  173.     annouce.c;announce.h    Announce engine
  174.     crc32.c;crc32.h         Calculate CRC32
  175.  
  176.     [sample config files]
  177.     bermuda.cfg             Sample Bermuda config
  178.     fareas.bbs              Sample fareas.bbs
  179.     areas.bbs               Sample areas.bbs
  180.  
  181.     [documentation]
  182.     lazytick.txt            (this file)
  183.     readme.txt              Readme file (history/bugs)
  184.  
  185.     [makefiles]
  186.     makefile.nix            Unix makefile
  187.     makefile.nt             Win32 makefile
  188.     tick.prj                Lattice C 5.5 Project file
  189.     
  190.  
  191. >>> LICENSE
  192. -----------
  193.  
  194.     This software is public domain.
  195.     It can be copied and sold freely.
  196.  
  197.     (yeah, it can be sold, i'm bored by all those restrictive licenses)
  198.  
  199. >>> SUPPORT
  200. -----------
  201.  
  202.     This software is not likely to do what you want it to do. It is 
  203.     not supported. Have fun :-).
  204.  
  205.  
  206. >>> CREDITS
  207. -----------
  208.  
  209.     Software & doc originally written by Franck Arnaud.
  210.     Parts by Jac Kersing (Bermuda) & someone else (CRC32).
  211.     LazyTick, LazyBBS, and LazyFix are not trademarks. :-)
  212.     The authors disclaim everything. Whatever happens,
  213.     it IS your own stupid fault.
  214.  
  215.